IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/librw/RWTPtrMapIterator.z/RWTPtrMapIterator

Text File | 2002-10-03 | 7.2 KB | 199 lines

RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                                RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWTPtrMapIterator<K,T,C> - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include<rw/tpmap.h>



              RWTPMap<K,T,C> map;
          RWTPMapIterator<K,T,C> itr(map);

SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy DDDDeeeeppppeeeennnnddddeeeennnntttt!!!!
     RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr requires the Standard C++ Library.






DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     RRRRWWWWTTTTPPPPrrrrttttMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr is supplied with Tools 7 to provide an iterator
     interface to the new Standard Library based collections that has backward
     compatibility with the container iterators provided in Tools 6. The order
     of iteration over an RRRRWWWWTTTTPPPPttttrrrrMMMMaaaapppp is dependent on the comparator object
     supplied as applied to the key values of the stored associations.  The
     current item referenced by this iterator is undefined after construction
     or after a call to rrrreeeesssseeeetttt(((()))).  The iterator becomes valid after being
     advanced with either a preincrement or ooooppppeeeerrrraaaattttoooorrrr(((()))).  For both ooooppppeeeerrrraaaattttoooorrrr++++++++
     and ooooppppeeeerrrraaaattttoooorrrr(((()))), iterating past the last element will return a value
     equivalent to boolean ffffaaaallllsssseeee.  Continued increments will return a value
     equivalent to ffffaaaallllsssseeee until rrrreeeesssseeeetttt(((()))) is called.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None

EEEExxxxaaaammmmpppplllleeeessss
              #include<rw/tpmap.h>



              #include<iostream.h>
          #include<rw/cstring.h>
          int main(){
             RWTPtrMap<RWCString,int,less<RWCString> > age;
             RWTPtrMapIterator<RWCString,int,less<RWCString> > itr(age);
          age.insert(new RWCString("John") ,new int(30));
             age.insert(new RWCString("Steve"),new int(17));
             age.insert(new RWCString("Mark") ,new int(24));
          //Insertion is rejected, no duplicates allowed
             age.insert(new RWCString("Steve"),new int(24));
          for(;itr();)
               cout << *itr.key() << "'s age is " << *itr.value() << endl;



                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                                RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



                 return 0;



              }
          Program Output
          John's age is 30
          Mark's age is 24
          Steve's age is 17

PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
              RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr<<<<KKKK,,,,TTTT,,,,CCCC>>>>(const RWTPtrMap<K,T,C>& rwm);


     Creates an iterator for the map rrrrwwwwmmmm.  The iterator begins in an undefined
     state and must be advanced before the first element will be accessible

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
              K*
          ooooppppeeeerrrraaaattttoooorrrr(((())))();


     Advances self to the next element, dereferences the resulting iterator
     and returns its key.  If the iterator has advanced past the last item in
     the container,  the element returned will be a nnnniiiillll pointer equivalent to
     boolean ffffaaaallllsssseeee.

              RWBoolean
          ooooppppeeeerrrraaaattttoooorrrr++++++++();


     Advances self to the next element.  If the iterator has been reset or
     just created self will now reference the first element.  If, before
     iteration, self referenced the last association in the multimap, self
     will now point to an undefined value and a value equivalent to ffffaaaallllsssseeee will
     be returned.  Otherwise, a value equivalent to ttttrrrruuuueeee is returned. Note: no
     post-increment operator is provided.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
              RWTPtrMap<K,T,C>*
          ccccoooonnnnttttaaaaiiiinnnneeeerrrr(((()))) const;


     Returns a pointer to the collection being iterated over.

              K*
          kkkkeeeeyyyy() const;


     Returns the key portion of the association currently referenced by self.
     Undefined if self is not referencing a value within the map.




                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                                RRRRWWWWTTTTPPPPttttrrrrMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



              void
          rrrreeeesssseeeetttt();
          void
          rrrreeeesssseeeetttt(RWTPtrMap<K,T,C>& h);


     Resets the iterator so that after being advanced it will reference the
     first element of the collection.  Using rrrreeeesssseeeetttt(((()))) with no argument will
     reset the iterator on the current container.  Supplying a RRRRWWWWTTTTPPPPttttrrrrMMMMaaaapppp to
     rrrreeeesssseeeetttt(((()))) will reset the iterator on that container.

              T*
          vvvvaaaalllluuuueeee();


     Returns the value portion of the association pointed to by self.
     Undefined if self is not referencing a value within the map.






































                                                                        PPPPaaaaggggeeee 3333